home *** CD-ROM | disk | FTP | other *** search
/ Programmer Power Tools / Programmer Power Tools.iso / icon / read.me < prev    next >
Text File  |  1985-12-03  |  8KB  |  265 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                  Version 5.9 of Icon for MS-DOS
  8.  
  9.  
  10.  
  11.  
  12.    This diskette contains executable binary files for Version 5.9
  13. of Icon running under MS-DOS. This implementation should run on
  14. an IBM PC, XT, AT or other 8086/88/186/286 family computer.  IBM
  15. PC hardware equivalence is not required; only DOS compatibility
  16. is needed:  PC- or MS-DOS Version 2.0 or above.  It is a small
  17. memory model implementation and requires 192 KB of memory during
  18. execution.  An 8087 will be used if it is present.
  19.  
  20.    This implementation was done by Cheyenne Wills of Mechan-
  21. icsburg, Pennsylvania.  He has placed it in the public domain to
  22. make it as widely available as possible.  He also provided the
  23. technical information contained in this document.
  24.  
  25.    This material is being distributed by the University of
  26. Arizona as a service to the computing community. It makes no war-
  27. ranties of any kind as to the correctness or suitability of this
  28. material for any application.
  29.  
  30.    This diskette can be copied and used freely, provided the
  31. material on it is not modified and that appropriate credit is
  32. given where applicable. Persons who obtain a copy of this
  33. diskette from a secondary source are encouraged to register their
  34. copy by sending a completed copy of the registration form on this
  35. diskette (REGIS.FRM) to:
  36.  
  37.         Icon Project
  38.         Department of Computer Science
  39.         The University of Arizona
  40.         Tucson, AZ   85721
  41.  
  42. Persons who register their copies will receive the Icon
  43. Newsletter, which is published aperiodically, free of charge and
  44. will be notified of corrections, new releases, and so forth.
  45.  
  46. Documentation
  47.  
  48.    Version 5 of the Icon programming language is described in the
  49. following book:
  50.  
  51.      The Icon Programming Language, Ralph E. Griswold and Madge
  52.      T.  Griswold, Prentice-Hall, Inc., Englewood Cliffs, New
  53.      Jersey.  1983. ISBN 0-13-449777-5.
  54.  
  55. A brief overview of Icon is contained in the file OVERVIEW.DOC on
  56. this diskette.  Features that have been added to Version 5 of
  57. Icon since the book was written are described in the file
  58. EXTEN.DOC.  Printed copies of these documents are available on
  59. request from the Icon Project at the address listed above.
  60.  
  61.  
  62.  
  63.  
  64.                               - 1 -
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73. Installing MS-DOS Icon
  74.  
  75.    The four executable binary files need to run Icon are:
  76.  
  77.         ICONT.EXE  command processor
  78.         ITRAN.EXE  translator
  79.         ILINK.EXE  linker
  80.         ICONX.EXE  interpreter
  81.  
  82. These files can be copied to any location that is accessible via
  83. the current PATH setting.
  84.  
  85. Running MS-DOS Icon
  86.  
  87.    Icon programs must have the extension .icn. An Icon program in
  88. the file prog.icn is translated by
  89.  
  90.         icont prog.icn
  91.  
  92. The result is a file with the name prog (with the extension
  93. removed).  This file can be run by
  94.  
  95.         iconx prog
  96.  
  97. Alternatively, the program can be run after translation by
  98.  
  99.         icont prog.icn -x
  100.  
  101. In this case the file prog also is left and can be run subse-
  102. quently using iconx.
  103.  
  104.    More information about running Icon is contained in RUN.DOC.
  105.  
  106. Testing MS-DOS Icon
  107.  
  108.    There are a few programs on the distribution diskette that may
  109. be used for testing Icon:
  110.  
  111.      hello.icn   This program prints the version, installation
  112.                  options, time, and date.  Run this test as
  113.  
  114.                          icont hello.icn -x
  115.  
  116.  
  117.      cross.icn   This program prints all the ways that two words
  118.                  intersect in a common character. The file
  119.                  cross.dat contains typical data. Run this test
  120.                  as
  121.  
  122.                          icont cross.icn -x <cross.dat
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.                               - 2 -
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.      meander.icn This program prints the "meandering strings"
  140.                  that contain all subsequences of a specified
  141.                  length from a given set of characters. Run this
  142.                  test as
  143.  
  144.                          icont meander.icn -x <meander.dat
  145.  
  146.  
  147.      roman.icn   This program converts Arabic numerals to Roman
  148.                  numerals. Run this test as
  149.  
  150.                          icont roman.icn -x
  151.  
  152.                  and provide some Arabic numbers from the con-
  153.                  sole.
  154.  
  155.      wordcnt.icn This program tabulates the number of occurrences
  156.                  of each word from the input file. Run this test
  157.                  as
  158.  
  159.                          icont wordcnt.icn -x <file
  160.  
  161.                  where file contains some text of interest.
  162.  
  163. Features of MS-DOS Icon
  164.  
  165.    MS-DOS Icon supports all the features of Version 5.9 of Icon,
  166. including sets and the experimental features described in
  167. EXTEN.DOC, with the following exceptions and additions:
  168.  
  169.      +  Pipes are not supported.  A file cannot be opened with
  170.         the "p" option.
  171.  
  172.      +  There is two new options for open: "t" and "u". "t" indi-
  173.         cates that the file is to be translated into UNIX format.
  174.         All carriage-return/line-feed sequences are translated
  175.         into newline sequences on both input and output.  "t" is
  176.         the default. "u" indicates that the file is to be
  177.         untranslated.  Examples are:
  178.  
  179.                 untranfile := open("test.fil","ru");
  180.                 tranfile := open("test.new","wt");
  181.  
  182.  
  183.      +  The IPATH environment string, as described in EXTEN.DOC
  184.         and RUN.DOC, is supported.  The separator between paths
  185.         is the semicolon.  The current directory is always
  186.         searched.  For example,
  187.  
  188.                 SET IPATH=A:\;A:\ICON\LIB
  189.  
  190.         searches the current directory, then root directory on
  191.         drive A, and finally the directory A:\ICON\LIB.
  192.  
  193.  
  194.  
  195.  
  196.                               - 3 -
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.      +  Path specifications can be entered using either a / or a
  206.         \ .  Examples are:
  207.  
  208.                 A:\ICON\TEST.ICN
  209.                 A:/ICON/TEST.ICN
  210.  
  211.  
  212.      +  The following MS-DOS device names can be used as
  213.         filenames:
  214.  
  215.                 AUX     Refers to an auxiliary device.
  216.                 CON     Refers to the console.
  217.                 PRN     Refers to the printer device.
  218.                 NUL     Specifies a "null" file.  Giving NUL as a filename means
  219.                            that no file is created.
  220.  
  221.         These special names remain associated with the devices
  222.         listed above, even if device designations or filename
  223.         extensions are added to them.  For example, A:CON.XXX
  224.         refers to the console and is not the name of a disk file.
  225.  
  226.      +  Trace output is sent to STDERR.  On MS-DOS STDERR is not
  227.         re-directable from the command line.
  228.  
  229.      Bugs and Limitations
  230.  
  231.         Since this is a small memory model implementation, the
  232.      amount of data available for a running program is limited.
  233.  
  234.         This is a new implementation and some problems with it
  235.      are likely to occur. Problems should be reported using the
  236.      trouble report form given in TROUBLE.FRM on the distribution
  237.      diskette.
  238.  
  239.         See RUN.DOC for a list of known bugs.
  240.  
  241.      Future Plans
  242.  
  243.         A large memory model implementation of Icon under MS-DOS
  244.      is underway.
  245.  
  246.         Material from the Icon program library is being adapted
  247.      to MS-DOS and will be distributed separately when it is
  248.      ready.
  249.  
  250.  
  251.  
  252.      Ralph E. Griswold
  253.  
  254.      Department of Computer Science
  255.      The University of Arizona
  256.  
  257.      September 30, 1985
  258.  
  259.  
  260.  
  261.  
  262.                               - 4 -
  263.  
  264.  
  265.